getting started with spring java guide #3897

christinaausley · 2024-06-06T18:21:33Z

Description

Related to https://github.com/camunda/product-hub/issues/2146.

Drafted Spring/Java guide based on developed work by @pepopowitz in https://github.com/camunda/camunda-8-get-started-spring.

Need to

Add to sidebar -- where would we want this to live?
Backport upon approval

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2024-06-06T18:21:57Z

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

docs/guides/getting-started-java-spring.md

Co-authored-by: Amara Graham <[email protected]>

docs/guides/getting-started-java-spring.md

pepopowitz

Nice work Christina!

I have a few non-blocking comments, and a handful of comments to add more precise language. The biggest concern for me is introducing code changes one snippet at a time -- I think it will lead to more mistakes, as I describe inline.

docs/guides/getting-started-java-spring.md

Co-authored-by: Steven Hicks <[email protected]>

christinaausley · 2024-06-11T18:13:15Z

@pepopowitz @akeller This is ready for another review 👍

pepopowitz

These changes are exactly what I was looking for, thank you!!!

Only one of my changes is blocking, but I do think it's important. I also added many non-blocking suggestions for your consideration.

docs/guides/getting-started-java-spring.md

akeller

Yes - this should go in the Guides sidebar as part of the getting started area. This will also kick-off some rework to make this area less SaaS-only, but that's outside the scope of this PR.

Keep in mind the versions when backporting. So for 8.5, yes it absolutely makes sense to keep the pom.xml file dependency at 8.5+. For /next/ you can do anything 8.5.0+, so incorporating the changes up until 8.6.0.

Are there any changes that need to be made to the code repo? Those need to be taken care of so we can merge and release this.

akeller · 2024-06-17T15:17:38Z

@crobbins215 will you review or should we merge?

crobbins215 · 2024-06-17T15:35:47Z

@crobbins215 will you review or should we merge?

I have read over it, and it looks good, I've not tested it for myself, time-limited at the moment, so as long as it's all working fine from the reviews it has had I'm happy to get it merged.

akeller · 2024-06-18T16:48:21Z

Added the alpha3 label retroactively since it's being delivered between alpha2 and alpha3.

christinaausley added 5 commits June 5, 2024 17:37

document prereqs

a8c3ffc

create a spring project

ebd043d

create a new BPMN diagram

b133b98

implement service task

56edb75

deploy

b5696ef

christinaausley added component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team labels Jun 6, 2024

christinaausley requested review from akeller, pepopowitz and crobbins215 June 6, 2024 18:21

christinaausley self-assigned this Jun 6, 2024